/* 
 * Copyright [2018] [Alex/libo(liboms@hotmail.com)]
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.hyts.apidoc.base;

import java.util.List;

/** 
 * @title BaseApiParser.java  
 * @package com.hyts.apidoc.base  
 * @description 操作抽象API解析器接口：用于处理对应的type类的解析器
 * 				有很多子类实现进行构建解析的不同方案以及类型  
 * @see TODO
 * @author libo/Alex
 * @email liboms@hotmail.com/liboware@163.com  
 * @date 2018年4月18日
 * @version V1.0 
 */
@FunctionalInterface
public interface BaseApiParser<I,R> {

	/**  
	 * <b>generateDoc</b>
	 * <p>创建Javadoc文本操作</p>
	 * @param param 参数类型：可以为javadoc解析出的api结果
	 * 						   可以为注解操作所生成的api结果
	 * @return List<T> 泛型结果集合：用于返回解析后的结果集合
	 * @exception
	 */ 
	List<R> generateDoc(I param);
	
}
